<Source>.ListSpatialKeys (Function)

ONLINE HELP
WINDEV, WEBDEV AND WINDEV MOBILE

Version:

Home | Sign in | English

New WINDEV, WEBDEV and WINDEV Mobile 2024 feature!

Help / WLanguage / Managing databases / HFSQL / HFSQL functions

WINDEV

WEBDEV

WINDEV Mobile

Others

See also

<Source>.ListSpatialKeys (Function)

In french: <Source>.ListeClésSpatiales

Returns the spatial keys of a data file (used in a query or view) recognized by the HFSQL engine.

Example

// Get the spatial keys of a data file in the current analysis
SpatialKeyList is string
SpatialKeyList = Towns.ListSpatialKeys()
// Adds the list of spatial keys to COMBO_Combo1
COMBO_Combo1.Add(SpatialKeyList)

Syntax

<Result> = <Source>.ListSpatialKeys([<Path of the WDD file> [, <Password of the WDD file>]])

<Result>: Character string

List of spatial items in the specified data file. Names of spatial items are separated by CR (carriage return).

<Source>: Type corresponding to the specified source

Name of the data file, query or view with spatial keys to be listed.
If a query name is specified, this query must be currently run (<Source>.ExecuteQuery or <Source>.ExecuteSQLQuery) in order for <Source>.ListSpatialKeys to operate. Otherwise, a WLanguage error occurs.

<Path of the WDD file>: Optional character string

Full path of the analysis (which means .WDD file) in which the data file is described.
If this parameter is not specified or if it is equal to an empty string (""), the data file is sought in the current analysis.

<Password of the WDD file>: Optional character string

Password defined for the analysis.
If no password is defined, this parameter must be equal to an empty string ("").

Business / UI classification: Business Logic

Component: wd290hf.dll